<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>websocket::stream::handshake_ex (1 of 4 overloads)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
<link rel="up" href="../handshake_ex.html" title="websocket::stream::handshake_ex">
<link rel="prev" href="../handshake_ex.html" title="websocket::stream::handshake_ex">
<link rel="next" href="overload2.html" title="websocket::stream::handshake_ex (2 of 4 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../handshake_ex.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../handshake_ex.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::handshake_ex (1 of 4 overloads)">websocket::stream::handshake_ex
          (1 of 4 overloads)</a>
</h6></div></div></div>
<p>
            Send an HTTP WebSocket Upgrade request and receive the response.
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.h0"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.synopsis">Synopsis</a>
          </h7><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">class</span> <span class="identifier">RequestDecorator</span><span class="special">&gt;</span>
<span class="keyword">void</span>
<span class="identifier">handshake_ex</span><span class="special">(</span>
    <span class="identifier">string_view</span> <span class="identifier">host</span><span class="special">,</span>
    <span class="identifier">string_view</span> <span class="identifier">target</span><span class="special">,</span>
    <span class="identifier">RequestDecorator</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">decorator</span><span class="special">);</span>
</pre>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.h1"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.description">Description</a>
          </h7><p>
            This function is used to synchronously send the WebSocket upgrade HTTP
            request. The call blocks until one of the following conditions is true:
          </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
                The request is sent and the response is received.
              </li>
<li class="listitem">
                An error occurs on the stream
              </li>
</ul></div>
<p>
            This function is implemented in terms of one or more calls to the next
            layer's <code class="computeroutput"><span class="identifier">read_some</span></code> and
            <code class="computeroutput"><span class="identifier">write_some</span></code> functions.
          </p>
<p>
            The operation is successful if the received HTTP response indicates a
            successful HTTP Upgrade (represented by a Status-Code of 101, "switching
            protocols").
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.h2"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.parameters">Parameters</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">host</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The name of the remote host, required by the HTTP protocol.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">target</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The Request Target, which may not be empty, required by the
                      HTTP protocol.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">decorator</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      A function object which will be called to modify the HTTP request
                      object generated by the implementation. This could be used
                      to set the User-Agent field, subprotocols, or other application
                      or HTTP specific fields. The object will be called with this
                      equivalent signature:
                    </p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"> <span class="keyword">void</span> <span class="identifier">decorator</span><span class="special">(</span>
    <span class="identifier">request_type</span><span class="special">&amp;</span> <span class="identifier">req</span>
<span class="special">);</span>
</pre>
                  </td>
</tr>
</tbody>
</table></div>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.h3"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.exceptions"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.exceptions">Exceptions</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Type
                    </p>
                  </th>
<th>
                    <p>
                      Thrown On
                    </p>
                  </th>
</tr></thead>
<tbody><tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">system_error</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      Thrown on failure.
                    </p>
                  </td>
</tr></tbody>
</table></div>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.h4"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.example"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake_ex.overload1.example">Example</a>
          </h7><pre class="programlisting"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">&lt;</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span><span class="special">&gt;</span> <span class="identifier">ws</span><span class="special">{</span><span class="identifier">io_context</span><span class="special">};</span>
<span class="special">...</span>
<span class="keyword">try</span>
<span class="special">{</span>
    <span class="identifier">ws</span><span class="special">.</span><span class="identifier">handshake</span><span class="special">(</span><span class="string">"localhost"</span><span class="special">,</span> <span class="string">"/"</span><span class="special">,</span>
        <span class="special">[](</span><span class="identifier">request_type</span><span class="special">&amp;</span> <span class="identifier">req</span><span class="special">)</span>
        <span class="special">{</span>
            <span class="identifier">req</span><span class="special">.</span><span class="identifier">set</span><span class="special">(</span><span class="identifier">field</span><span class="special">::</span><span class="identifier">user_agent</span><span class="special">,</span> <span class="string">"Beast"</span><span class="special">);</span>
        <span class="special">});</span>
<span class="special">}</span>
<span class="keyword">catch</span><span class="special">(...)</span>
<span class="special">{</span>
    <span class="comment">// An error occurred.</span>
<span class="special">}</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2016, 2017 Vinnie Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../handshake_ex.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../handshake_ex.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
